home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / listem31.zip / LISTEM.DOC < prev    next >
Text File  |  1992-04-16  |  9KB  |  261 lines
  1.  
  2.       ============================= LISTEM ==============================
  3.  
  4.                      Searchlight BBS File Directory Lister
  5.               Copyright(C) 1991,92  BiBass Software, by Kevin Bass
  6.                               ALL RIGHTS RESERVED
  7.  
  8.  
  9.     - WHAT IS LISTEM
  10.  
  11.     This program reads  one  or  more  Searchlight BBS file directories (as
  12.     defined in FILEDIR.SL2)   and  creates    an   all   file   listing  in
  13.     alphabetical order to  standard output.  Command line  options  can  be
  14.     provided to specify  what  directories to process, to limit the listing
  15.     to certain directories, to display new  files for the week or month, or
  16.     to search for particular files.  The final result can be printed to the
  17.     monitor screen, redirected  to  a text file or the printer,   or  piped
  18.     into another process.
  19.  
  20.  
  21.  
  22.  
  23.     - LISTEM FEATURES
  24.  
  25.     *  Include or exclude single directories.
  26.  
  27.     *  Include or exclude a list of directories via indirect file list.
  28.  
  29.     *  Toggle long descriptions on.  Default is off.
  30.  
  31.     *  Reformat long  descriptions to 3 lines of 40 characters.  Default is
  32.        2 lines of 60 characters.
  33.  
  34.     *  Create weekly or monthly lists.
  35.  
  36.     *  Use different header files for special lists.
  37.  
  38.     *  Redirect output.  However, if redirection is not allowed, LISTEM can
  39.        create an output file for you.
  40.  
  41.     *  Create a  list by doing case-insensitive  string  searches  on  file
  42.        names and descriptions.
  43.  
  44.     *  Fast and flexible!
  45.  
  46.                                  AND MUCH MORE!
  47.  
  48.  
  49.  
  50.  
  51.     - LISTEM ARCHIVE FILE CONTENTS
  52.  
  53.     The LISTEM package  consists  of six disk files.  Make  sure  you  have
  54.     them:
  55.                             (x's donate version number)
  56.  
  57.     LISTEMxx.EXE     - The executable file.
  58.     LISTEM.KEY       - KEY file needed to run LISTEM.
  59.     LISTEM.DOC       - Basic instruction manual for LISTEM.
  60.     REGISTER.FRM     - Registration form for LISTEM.
  61.     DISTRIB.TXT      - List of distribution BBS for BiBass Software.
  62.  
  63.  
  64.                                      Page 1
  65.        LISTEM - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  66.  
  67.     -  COPYRIGHT AND LICENSE INFORMATION
  68.  
  69.     LISTEM and its documentation are Copyright(C) 1992 BiBass Software, all
  70.     rights reserved worldwide.    They   may   not  be  circulated  in  any
  71.     incomplete or modified  form, nor  sold  for  profit,  without  written
  72.     permission of the   author.   The  use  of  LISTEM is  subject  to  the
  73.     following terms:
  74.  
  75.     PERSONAL USE.  Individuals  who  use LISTEM must register their copy if
  76.     they find the program useful.  A registration  form   is  provided  for
  77.     your  convenience.  If  you  want  to be sure of obtaining  the  LATEST
  78.     version of LISTEM,  you can download the archive file LISTEMxx.ZIP from
  79.     one of the three primary distribution sites:
  80.  
  81.               1.  Kev's Korner   - Quinlan, Texas  (903) 883-4753.
  82.  
  83.     If you have any questions or comments about LISTEM, please write.
  84.  
  85.                    Address all correspondence to the author:
  86.  
  87.                                    Kevin Bass
  88.                                Route 3 Box 368A-1
  89.                            Quinlan, Texas  75401  USA
  90.  
  91.     DISCLAIMER: You undertake to use LISTEM  at your own risk.   The author
  92.     assumes no liability for damages of any kind resulting  from the use of
  93.     LISTEM.
  94.  
  95.  
  96.  
  97.  
  98.     - REQUIREMENTS
  99.  
  100.     * MS-DOS 3.1 or higher.
  101.     * Searchlight 2.0 or higher.
  102.  
  103.  
  104.  
  105.     - SETTING UP LISTEM
  106.  
  107.     1.  Place a  copy of LISTEMxx.EXE in your BBS data directory (directory
  108.         that contains FILEDIR.SL2).
  109.  
  110.  
  111.  
  112.  
  113.     - SYNTAX
  114.  
  115.     The syntax for running LISTEM is as follows:
  116.  
  117.          LISTEM [parameters]
  118.  
  119.     The following command line parameters can be used:
  120.  
  121.          [access]      Maximum access level (Default is 255)
  122.          [=string]     Search string (Case-insensitive)
  123.          [+dir]        Display directory "dir" (Default is ALL)
  124.          [-dir]        Display all directories except "dir"
  125.          [+@file.ext]  Display directories in list (TEXT)
  126.          [-@file.ext]  Display all directories except in list (TEXT)
  127.          [!file.ext]   Specify header file (Default is LISTEM.HDR)
  128.  
  129.                                      Page 2
  130.        LISTEM - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  131.  
  132.          [*file.ext]   Alternate way of specifying output file.
  133.          [/E]          Display extended descriptions
  134.  
  135.                        E followed   by   a   R   will   reformat   extended
  136.                        descriptions
  137.  
  138.          [/D]          Process by date.
  139.  
  140.                        D followed by W means process by week.
  141.                        D followed by M means process by month.
  142.  
  143.     All parameters are  optional.   If   no   parameters   are   given  all
  144.     directories processed and displayed.
  145.  
  146.     If [access] is included, LISTEM will  process only  directories with
  147.     an access level  less  than  or   equal to  the specified   number.   A
  148.     number from  0 to  255 should be specified.  For example:
  149.  
  150.     > LISTEM 100
  151.  
  152.     will omit any  directories  with  access levels of 101 or  greater from
  153.     the final list.
  154.  
  155.     If [=string] is included, only files  and descriptions  containing this
  156.     search string will  be  printed  in   the   final   list.   It's  case-
  157.     insensative.  For example, use the following to list all  files on your
  158.     system with the string "scan"  in their filename or description:
  159.  
  160.     > LISTEM =SCAN (or scan)
  161.  
  162.  
  163.     The [+dir] option,  where "dir" is the name of the directory, indicates
  164.     that ONLY these directories will be included in the list.  For example,
  165.     to get a quick look at your letter 'UPLOADS' directory from the command
  166.     line, you would type this:
  167.  
  168.     > LISTEM +UPLOADS
  169.  
  170.  
  171.     If [-dir] is included,  these directories   will  be  excluded from the
  172.     list.  For example,  you  want to list all directories  except  in  the
  173.     "GENERAL" directory:
  174.  
  175.     > LISTEM -GENERAL
  176.  
  177.  
  178.     The [+@file.ext] and  [-@file.ext]  options  allow  you  to  specify an
  179.     external list of directories to include or exclude.  The list is stored
  180.     in the text  file specified (EXAMPLE:  If  the  file  is  GRAPHICS.TXT,
  181.     specify +@GRAPHICS.TXT or -@GRAPHICS.TXT).  The file should  contain an
  182.     ASCII list of directory names, one per line.
  183.  
  184.  
  185.     If an access  level  parameter  is  used  together  with  a  "+" or "-"
  186.     parameter,  the options will work together; only directories which meet
  187.     both specifications  of both parameters will be displayed.  You can use
  188.     "+" and "-" together.
  189.  
  190.  
  191.     If [!file.ext] is included,  this header  file will  be used  and shown
  192.     at the front  of  the list.   The default   is  LISTEM.HDR.    This  is
  193.  
  194.                                      Page 3
  195.        LISTEM - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  196.  
  197.     useful if you  use  different  header files for  different lists.   For
  198.     example,  let's say you are going to  use a  specified header  file for
  199.     your program  file listing  called "PROGRAM.HDR":
  200.  
  201.     > LISTEM !PROGRAM.HDR
  202.  
  203.  
  204.     If [/E] is included, long descriptions will be displayed.  You also can
  205.     use [/ER] to reformat long descriptions.   4  lines  of  40  characters
  206.     looks more appealing than 1 line of 40 characters and  2  lines  of  60
  207.     characters in my opinion.
  208.  
  209.  
  210.     If [/Dx] is  included, a weekly or monthly files lists will be created.
  211.     [/DW] creates weekly, while [/DM] creates monthly.  This can be used to
  212.     create a weekly or monthly new files  lists.   Lists  will be created a
  213.     week or month back respectively from the time LISTEM is executed.
  214.  
  215.  
  216.  
  217.  
  218.     - HOW DO I REDIRECT MY LIST TO A FILE?
  219.  
  220.     If you want to redirect your list to a file, you provide  the following
  221.     command:
  222.  
  223.     > LISTEM >ALLFILES.TXT
  224.  
  225.  
  226.     If you want to create the list in your upload  directory, you  would do
  227.     the following (assuming your upload directory is on drive D: and called
  228.     "UPLOAD"):
  229.  
  230.      > LISTEM >D:\UPLOAD\ALLFILES.TXT
  231.  
  232.  
  233.     Under some operation   systems,  redirection  is  not  allowed.   Using
  234.     [*file.ext] will allow you to specify  the  name  of  your  output file
  235.     list.  For example,  to create an output file called  ALLFILES.TXT,  do
  236.     the following:
  237.  
  238.     > LISTEM *ALLFILES.TXT
  239.  
  240.  
  241.  
  242.  
  243.     - HOW DO I REGISTER MY COPY OF LISTEM?
  244.  
  245.     If you use  LISTEM longer than 30 days, you need to register your copy.
  246.     Please fill out the registration from  (REGISTER.FRM)  and  send  to me
  247.     along with your payment.  Upon receiving your registration  fee, I will
  248.     create a registered  KEY  file for you to download from my BBS.  If you
  249.     are FIDOnet or SLnet compatible, I will NETmail your key to you.
  250.  
  251.  
  252.     - ACKNOWLEDGMENTS
  253.  
  254.     *  Turbo Pascal is a trademark of Borland International, Inc.
  255.     *  Searchlight is a trademark of Searchlight Software by Frank LaRosa.
  256.     *  IBM is a trademark of International Business Machine Corporation.
  257.     * MS-DOS is a trademark of MicroSoft Corporation.
  258.  
  259.                                      Page 4
  260.        LISTEM - Copyright(C) 1992 BiBass Software.  ALL RIGHTS RESERVED.
  261.